<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *     http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    package org.apache.commons.jxpath;<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    import java.util.Iterator;<a name="line.19"></a>
<FONT color="green">020</FONT>    <a name="line.20"></a>
<FONT color="green">021</FONT>    /**<a name="line.21"></a>
<FONT color="green">022</FONT>     * Represents a compiled XPath. The interpretation of compiled XPaths<a name="line.22"></a>
<FONT color="green">023</FONT>     * may be faster, because it bypasses the compilation step. The reference<a name="line.23"></a>
<FONT color="green">024</FONT>     * implementation of {@link JXPathContext} also globally caches some of the<a name="line.24"></a>
<FONT color="green">025</FONT>     * results of compilation, so the direct use of JXPathContext is not<a name="line.25"></a>
<FONT color="green">026</FONT>     * always less efficient than the use of CompiledExpression.<a name="line.26"></a>
<FONT color="green">027</FONT>     * &lt;p&gt;<a name="line.27"></a>
<FONT color="green">028</FONT>     * Use CompiledExpression only when there is a need to evaluate the<a name="line.28"></a>
<FONT color="green">029</FONT>     * same expression multiple times and the CompiledExpression can be<a name="line.29"></a>
<FONT color="green">030</FONT>     * conveniently cached.<a name="line.30"></a>
<FONT color="green">031</FONT>     * &lt;p&gt;<a name="line.31"></a>
<FONT color="green">032</FONT>     * To acquire a CompiledExpression, call {@link JXPathContext#compile<a name="line.32"></a>
<FONT color="green">033</FONT>     * JXPathContext.compile}<a name="line.33"></a>
<FONT color="green">034</FONT>     *<a name="line.34"></a>
<FONT color="green">035</FONT>     * @author Dmitri Plotnikov<a name="line.35"></a>
<FONT color="green">036</FONT>     * @version $Revision: 652845 $ $Date: 2008-05-02 12:46:46 -0500 (Fri, 02 May 2008) $<a name="line.36"></a>
<FONT color="green">037</FONT>     */<a name="line.37"></a>
<FONT color="green">038</FONT>    public interface CompiledExpression {<a name="line.38"></a>
<FONT color="green">039</FONT>    <a name="line.39"></a>
<FONT color="green">040</FONT>        /**<a name="line.40"></a>
<FONT color="green">041</FONT>         * Evaluates the xpath and returns the resulting object. Primitive<a name="line.41"></a>
<FONT color="green">042</FONT>         * types are wrapped into objects.<a name="line.42"></a>
<FONT color="green">043</FONT>         * @param context to evaluate<a name="line.43"></a>
<FONT color="green">044</FONT>         * @return Object<a name="line.44"></a>
<FONT color="green">045</FONT>         */<a name="line.45"></a>
<FONT color="green">046</FONT>        Object getValue(JXPathContext context);<a name="line.46"></a>
<FONT color="green">047</FONT>    <a name="line.47"></a>
<FONT color="green">048</FONT>        /**<a name="line.48"></a>
<FONT color="green">049</FONT>         * Evaluates the xpath, converts the result to the specified class and<a name="line.49"></a>
<FONT color="green">050</FONT>         * returns the resulting object.<a name="line.50"></a>
<FONT color="green">051</FONT>         * @param context to evaluate<a name="line.51"></a>
<FONT color="green">052</FONT>         * @param requiredType return type<a name="line.52"></a>
<FONT color="green">053</FONT>         * @return Object<a name="line.53"></a>
<FONT color="green">054</FONT>         */<a name="line.54"></a>
<FONT color="green">055</FONT>        Object getValue(JXPathContext context, Class requiredType);<a name="line.55"></a>
<FONT color="green">056</FONT>    <a name="line.56"></a>
<FONT color="green">057</FONT>        /**<a name="line.57"></a>
<FONT color="green">058</FONT>         * Modifies the value of the property described by the supplied xpath.<a name="line.58"></a>
<FONT color="green">059</FONT>         * Will throw an exception if one of the following conditions occurs:<a name="line.59"></a>
<FONT color="green">060</FONT>         * &lt;ul&gt;<a name="line.60"></a>
<FONT color="green">061</FONT>         * &lt;li&gt;The xpath does not in fact describe an existing property<a name="line.61"></a>
<FONT color="green">062</FONT>         * &lt;li&gt;The property is not writable (no public, non-static set method)<a name="line.62"></a>
<FONT color="green">063</FONT>         * &lt;/ul&gt;<a name="line.63"></a>
<FONT color="green">064</FONT>         * @param context base<a name="line.64"></a>
<FONT color="green">065</FONT>         * @param value to set<a name="line.65"></a>
<FONT color="green">066</FONT>         */<a name="line.66"></a>
<FONT color="green">067</FONT>        void setValue(JXPathContext context, Object value);<a name="line.67"></a>
<FONT color="green">068</FONT>    <a name="line.68"></a>
<FONT color="green">069</FONT>        /**<a name="line.69"></a>
<FONT color="green">070</FONT>         * Creates intermediate elements of<a name="line.70"></a>
<FONT color="green">071</FONT>         * the path by invoking an {@link AbstractFactory}, which should first be<a name="line.71"></a>
<FONT color="green">072</FONT>         * installed on the context by calling {@link JXPathContext#setFactory}.<a name="line.72"></a>
<FONT color="green">073</FONT>         * @param context base<a name="line.73"></a>
<FONT color="green">074</FONT>         * @return Pointer created<a name="line.74"></a>
<FONT color="green">075</FONT>         */<a name="line.75"></a>
<FONT color="green">076</FONT>        Pointer createPath(JXPathContext context);<a name="line.76"></a>
<FONT color="green">077</FONT>    <a name="line.77"></a>
<FONT color="green">078</FONT>        /**<a name="line.78"></a>
<FONT color="green">079</FONT>         * The same as setValue, except it creates intermediate elements of<a name="line.79"></a>
<FONT color="green">080</FONT>         * the path by invoking an {@link AbstractFactory}, which should first be<a name="line.80"></a>
<FONT color="green">081</FONT>         * installed on the context by calling {@link JXPathContext#setFactory}.<a name="line.81"></a>
<FONT color="green">082</FONT>         * &lt;p&gt;<a name="line.82"></a>
<FONT color="green">083</FONT>         * Will throw an exception if one of the following conditions occurs:<a name="line.83"></a>
<FONT color="green">084</FONT>         * &lt;ul&gt;<a name="line.84"></a>
<FONT color="green">085</FONT>         * &lt;li&gt;Elements of the xpath aleady exist, by the path does not in<a name="line.85"></a>
<FONT color="green">086</FONT>         *  fact describe an existing property<a name="line.86"></a>
<FONT color="green">087</FONT>         * &lt;li&gt;The AbstractFactory fails to create an instance for an intermediate<a name="line.87"></a>
<FONT color="green">088</FONT>         * element.<a name="line.88"></a>
<FONT color="green">089</FONT>         * &lt;li&gt;The property is not writable (no public, non-static set method)<a name="line.89"></a>
<FONT color="green">090</FONT>         * &lt;/ul&gt;<a name="line.90"></a>
<FONT color="green">091</FONT>         * @param context base<a name="line.91"></a>
<FONT color="green">092</FONT>         * @param value to set<a name="line.92"></a>
<FONT color="green">093</FONT>         * @return Pointer created<a name="line.93"></a>
<FONT color="green">094</FONT>         */<a name="line.94"></a>
<FONT color="green">095</FONT>        Pointer createPathAndSetValue(JXPathContext context, Object value);<a name="line.95"></a>
<FONT color="green">096</FONT>    <a name="line.96"></a>
<FONT color="green">097</FONT>        /**<a name="line.97"></a>
<FONT color="green">098</FONT>         * Traverses the xpath and returns a Iterator of all results found<a name="line.98"></a>
<FONT color="green">099</FONT>         * for the path. If the xpath matches no properties<a name="line.99"></a>
<FONT color="green">100</FONT>         * in the graph, the Iterator will not be null.<a name="line.100"></a>
<FONT color="green">101</FONT>         * @param context base<a name="line.101"></a>
<FONT color="green">102</FONT>         * @return Iterator<a name="line.102"></a>
<FONT color="green">103</FONT>         */<a name="line.103"></a>
<FONT color="green">104</FONT>        Iterator iterate(JXPathContext context);<a name="line.104"></a>
<FONT color="green">105</FONT>    <a name="line.105"></a>
<FONT color="green">106</FONT>        /**<a name="line.106"></a>
<FONT color="green">107</FONT>         * Traverses the xpath and returns a Pointer.<a name="line.107"></a>
<FONT color="green">108</FONT>         * A Pointer provides easy access to a property.<a name="line.108"></a>
<FONT color="green">109</FONT>         * If the xpath matches no properties<a name="line.109"></a>
<FONT color="green">110</FONT>         * in the graph, the pointer will be null.<a name="line.110"></a>
<FONT color="green">111</FONT>         * @param context base<a name="line.111"></a>
<FONT color="green">112</FONT>         * @param xpath string<a name="line.112"></a>
<FONT color="green">113</FONT>         * @return Pointer found<a name="line.113"></a>
<FONT color="green">114</FONT>         */<a name="line.114"></a>
<FONT color="green">115</FONT>        Pointer getPointer(JXPathContext context, String xpath);<a name="line.115"></a>
<FONT color="green">116</FONT>    <a name="line.116"></a>
<FONT color="green">117</FONT>        /**<a name="line.117"></a>
<FONT color="green">118</FONT>         * Traverses the xpath and returns an Iterator of Pointers.<a name="line.118"></a>
<FONT color="green">119</FONT>         * A Pointer provides easy access to a property.<a name="line.119"></a>
<FONT color="green">120</FONT>         * If the xpath matches no properties<a name="line.120"></a>
<FONT color="green">121</FONT>         * in the graph, the Iterator be empty, but not null.<a name="line.121"></a>
<FONT color="green">122</FONT>         * @param context to iterate<a name="line.122"></a>
<FONT color="green">123</FONT>         * @return Iterator&lt;Pointer&gt;<a name="line.123"></a>
<FONT color="green">124</FONT>         */<a name="line.124"></a>
<FONT color="green">125</FONT>        Iterator iteratePointers(JXPathContext context);<a name="line.125"></a>
<FONT color="green">126</FONT>    <a name="line.126"></a>
<FONT color="green">127</FONT>        /**<a name="line.127"></a>
<FONT color="green">128</FONT>         * Remove the graph element described by this expression.<a name="line.128"></a>
<FONT color="green">129</FONT>         * @param context base<a name="line.129"></a>
<FONT color="green">130</FONT>         */<a name="line.130"></a>
<FONT color="green">131</FONT>        void removePath(JXPathContext context);<a name="line.131"></a>
<FONT color="green">132</FONT>    <a name="line.132"></a>
<FONT color="green">133</FONT>        /**<a name="line.133"></a>
<FONT color="green">134</FONT>         * Remove all graph elements described by this expression.<a name="line.134"></a>
<FONT color="green">135</FONT>         * @param context base<a name="line.135"></a>
<FONT color="green">136</FONT>         */<a name="line.136"></a>
<FONT color="green">137</FONT>        void removeAll(JXPathContext context);<a name="line.137"></a>
<FONT color="green">138</FONT>    }<a name="line.138"></a>




























































</PRE>
</BODY>
</HTML>
